home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / libraries / tri12dev.lha / Triton / Developer / Autodocs / triton.doc
Encoding:
Text File  |  1995-01-14  |  37.8 KB  |  1,239 lines
  1. TABLE OF CONTENTS
  2.  
  3. triton.lib/TR_CloseTriton
  4. triton.lib/TR_OpenTriton
  5. triton.library/class_Button
  6. triton.library/class_CheckBox
  7. triton.library/class_Cycle
  8. triton.library/class_DisplayObject
  9. triton.library/class_DropBox
  10. triton.library/class_FrameBox
  11. triton.library/class_Group
  12. triton.library/class_Image
  13. triton.library/class_Line
  14. triton.library/class_Listview
  15. triton.library/class_Object
  16. triton.library/class_Palette
  17. triton.library/class_Progress
  18. triton.library/class_Scroller
  19. triton.library/class_Slider
  20. triton.library/class_Space
  21. triton.library/class_String
  22. triton.library/class_Text
  23. triton.library/TR_AutoRequest
  24. triton.library/TR_CloseProject
  25. triton.library/TR_CloseWindowSafely
  26. triton.library/TR_CreateApp
  27. triton.library/TR_DeleteApp
  28. triton.library/TR_EasyRequest
  29. triton.library/TR_FirstOccurance
  30. triton.library/TR_GetAttribute
  31. triton.library/TR_GetErrorString
  32. triton.library/TR_GetLastError
  33. triton.library/TR_GetMsg
  34. triton.library/TR_LockProject
  35. triton.library/TR_LockScreen
  36. triton.library/TR_NumOccurances
  37. triton.library/TR_ObtainWindow
  38. triton.library/TR_OpenProject
  39. triton.library/TR_ReleaseWindow
  40. triton.library/TR_ReplyMsg
  41. triton.library/TR_SetAttribute
  42. triton.library/TR_UnlockProject
  43. triton.library/TR_UnlockScreen
  44. triton.library/TR_Wait
  45. triton.lib/TR_CloseTriton                           triton.lib/TR_CloseTriton
  46.  
  47.    NAME    
  48.     TR_CloseTriton -- Closes Triton easily.
  49.  
  50.    SYNOPSIS
  51.     TR_CloseTriton()
  52.  
  53.     VOID TR_CloseTriton(VOID);
  54.  
  55.    FUNCTION
  56.     Closes the application created by OpenTriton()
  57.     and closes triton.library.
  58.  
  59.    SEE ALSO
  60.     TR_OpenTriton()
  61.  
  62. triton.lib/TR_OpenTriton                             triton.lib/TR_OpenTriton
  63.  
  64.    NAME    
  65.     TR_OpenTriton -- Opens Triton ready to use.
  66.  
  67.    SYNOPSIS
  68.     success = TR_OpenTriton(version, tag1,...)
  69.     D0
  70.  
  71.     BOOL TR_OpenTriton(ULONG, ULONG,...);
  72.  
  73.    FUNCTION
  74.     Opens triton.library with the specified minimum
  75.     version and creates an application.
  76.     The supplied tags are passed as a taglist to
  77.     TR_CreateApp().
  78.  
  79.    RESULT
  80.     success - Was everything opened successful?
  81.  
  82.    SEE ALSO
  83.     TR_CloseTriton(), TR_CreateApp()
  84.  
  85. triton.library/class_Button                       triton.library/class_Button
  86.  
  87.    NAME    
  88.     class_Button -- A BOOPSI button gadget
  89.  
  90.    SUPERCLASS
  91.     class_DisplayObject (no attributes inherited)
  92.  
  93.    SYNOPSIS
  94.     TROB_Button
  95.  
  96.    ATTRIBUTES
  97.     <Default>        : ULONG buttontype
  98.                        - TRBT_TEXT         : Text button (default)
  99.                        - TRBT_GETFILE      : GetFile image button
  100.                        - TRBT_GETDRAWER    : GetDrawer image button
  101.                        - TRBT_GETENTRY     : GetEntry image button
  102.     TRAT_ID          : ULONG objectid
  103.     TRAT_Text        : STRPTR label
  104.     TRAT_Disabled    : BOOL disabled
  105.     TRAT_Flags       : ULONG flags
  106.                        - TRBU_RETURNOK     : Activated by <Return>
  107.                        - TRBU_ESCOK        : Activated by <Esc>
  108.                        - TRBU_SHIFTED      : Shifted shortcut only
  109.                        - TRBU_UNSHIFTED    : Unshifted shortcut only
  110.                        - TRBU_YRESIZE (V2) : When this flag is set, the
  111.                                              button will be vertically
  112.                                              resizeable. This is required
  113.                                              because beginning with V2
  114.                                              the height of objects which
  115.                                              are normally using the
  116.                                              button height can be
  117.                                              modified in the prefs
  118.                                              editor. Set this flags
  119.                                              WHEREVER POSSIBLE in order
  120.                                              to make buttons adopt to
  121.                                              higher objects in the same
  122.                                              horizontal group.
  123.  
  124. triton.library/class_CheckBox                   triton.library/class_CheckBox
  125.  
  126.    NAME    
  127.     class_CheckBox -- A GadTools checkbox gadget
  128.  
  129.    SUPERCLASS
  130.     class_DisplayObject
  131.  
  132.    SYNOPSIS
  133.     TROB_CheckBox
  134.  
  135.    ATTRIBUTES
  136.     <Default>        : <unused>
  137.     TRAT_Value       : BOOL checked
  138.  
  139. triton.library/class_Cycle                         triton.library/class_Cycle
  140.  
  141.    NAME    
  142.     class_Cycle -- A GadTools cycle gadget
  143.  
  144.    SUPERCLASS
  145.     class_DisplayObject (no attributes inherited)
  146.  
  147.    SYNOPSIS
  148.     TROB_Cycle
  149.  
  150.    ATTRIBUTES
  151.     <Default>        : STRPTR *entries    : Gadget etry labels
  152.                                             (create only)
  153.     TRAT_ID          : ULONG objectid
  154.     TRAT_Value       : ULONG number
  155.     TRAT_Disabled    : BOOL disabled      : Requires OS3.0+ when used
  156.                                             together with TRCY_MX.
  157.     TRAT_Flags       : ULONG flags (V2)
  158.                        - TRCY_MX          : "Unfold" the cycle gadget to
  159.                                             a mutually exclusive gadget.
  160.                        - TRCY_RIGHTLABELS : Put the labels to the right
  161.                                             side (TRCY_MX only).
  162.  
  163. triton.library/class_DisplayObject         triton.library/class_DisplayObject
  164.  
  165.    NAME    
  166.     class_DisplayObject -- An abstract display object
  167.  
  168.    SUPERCLASS
  169.     class_Object
  170.  
  171.    SYNOPSIS
  172.     TROB_DisplayObject
  173.  
  174.    ATTRIBUTES
  175.     <Default>        : <unused>
  176.     TRAT_ID          : ULONG objectid
  177.     TRAT_Disabled    : BOOL disabled
  178.  
  179. triton.library/class_DropBox                     triton.library/class_DropBox
  180.  
  181.    NAME    
  182.     class_DropBox -- An icon drop box
  183.  
  184.    SUPERCLASS
  185.     class_DisplayObject
  186.  
  187.    SYNOPSIS
  188.     TROB_DropBox
  189.  
  190.    ATTRIBUTES
  191.     <Default>        : <unused>
  192.  
  193. triton.library/class_FrameBox                   triton.library/class_FrameBox
  194.  
  195.    NAME    
  196.     class_FrameBox -- A framing box
  197.  
  198.    SUPERCLASS
  199.     class_DisplayObject (no attributes inherited)
  200.  
  201.    SYNOPSIS
  202.     TROB_FrameBox
  203.  
  204.    ATTRIBUTES
  205.     <Default>        : ULONG boxtype (V2)
  206.                          If no flag is set, unnamed boxes will
  207.                          be grouping and named ones framing.
  208.                        - TRFB_TEXT       : A text container
  209.                        - TRFB_GROUPING   : A grouping box
  210.                        - TRFB_FRAMING    : A framing box.
  211.     TRAT_ID          : ULONG objectid (V2)
  212.     TRAT_Backfill    : ULONG pattern
  213.     TRAT_Text        : STRPTR label (V2)
  214.     <other>          : <Child object>
  215.  
  216. triton.library/class_Group                         triton.library/class_Group
  217.  
  218.    NAME    
  219.     class_Group -- A grouping object
  220.  
  221.    SUPERCLASS
  222.     class_DisplayObject (no attributes inherited)
  223.  
  224.    SYNOPSIS
  225.     TRGR_Horiz
  226.     TRGR_Vert
  227.  
  228.    ATTRIBUTES
  229.     <Default>        : ULONG flags
  230.                        - TRGR_PROPSHARE  : Divide objects
  231.                                            proportionally
  232.                        - TRGR_EQUALSHARE : Divide objects equally
  233.                        - TRGR_PROPSPACES : Divide spaces
  234.                                            proportionally
  235.                        - TRGR_ARRAY      : Top group of an array. Lines
  236.                                            or culumns can be built
  237.                                            using TRGR_PROPSHARE groups.
  238.                                            At least one group must
  239.                                            be contained in an array.
  240.                        - TRGR_ALIGN      : Align resizeable objects in
  241.                                            their secondary dimension
  242.                        - TRGR_CENTER     : Center non-resizeable
  243.                                            objects in their secondary
  244.                                            dimension
  245.                        - TRGR_FIXHORIZ   : Don't allow horizontal
  246.                                            resizing
  247.                        - TRGR_FIXVERT    : Don't allow vertical
  248.                                            resizing
  249.                        - TRGR_INDEP (V2) : Group is independent of
  250.                                            surrounding array
  251.     <other>          : <treated as elements of the group>
  252.     TRGR_End         : <unused> : Marks the end of the group
  253.  
  254. triton.library/class_Image                         triton.library/class_Image
  255.  
  256.    NAME    
  257.     class_Image -- An image (V2)
  258.  
  259.    SUPERCLASS
  260.     class_DisplayObject (no attributes inherited)
  261.  
  262.    SYNOPSIS
  263.     TROB_Image
  264.  
  265.    ATTRIBUTES
  266.     <Default>        : <Image>
  267.     TRAT_Flags       : ULONG flags
  268.                        - TRIM_BOOPSI : <Default> is a pointer to a
  269.                                        struct IClass BOOPSI image class.
  270.     TRAT_MinWidth    : Minimum image width in pixels. Defaults to
  271.                        the image button height.
  272.     TRAT_MinHeight   : Minimum image height in pixels. Defaults to
  273.                        the image button height.
  274.     TRAT_ID          : ULONG objectid
  275.  
  276. triton.library/class_Line                           triton.library/class_Line
  277.  
  278.    NAME    
  279.     class_Line -- A 3D line
  280.  
  281.    SUPERCLASS
  282.     class_DisplayObject
  283.  
  284.    SYNOPSIS
  285.     TROB_Line
  286.  
  287.    ATTRIBUTES
  288.     <Default>        : ULONG flags
  289.                        - TROF_HORIZ        : Horizontal line
  290.                                              (Overrides group dimension)
  291.                        - TROF_VERT         : Vertical line
  292.                                              (Overrides group dimension)
  293.                        - TROF_RAISED       : Raised line
  294.  
  295. triton.library/class_Listview                   triton.library/class_Listview
  296.  
  297.    NAME
  298.     class_Listview -- A GadTools Listview gadget
  299.  
  300.    SUPERCLASS
  301.     class_DisplayObject (no attributes inherited)
  302.  
  303.    SYNOPSIS
  304.     TROB_Listview
  305.  
  306.    ATTRIBUTES
  307.     <Default>        : struct List *entries
  308.     TRAT_ID          : ULONG objectid
  309.     TRAT_Disabled    : BOOL disabled
  310.     TRAT_Flags       : ULONG flags
  311.                        - Listview type (mutually exclusive):
  312.                          - TRLV_READONLY     : A read-only list
  313.                          - TRLV_SELECT       : You may select an entry
  314.                          - TRLV_SHOWSELECTED : Show selected entry
  315.                        - TRLV_NOCURSORKEYS   : Don't use arrow keys
  316.                        - TRLV_NONUMPADKEYS   : Don't use keypad keys
  317.                        - TRLV_FWFONT         : Use the fixed-width font
  318.                        - TRLV_NOGAP (V2)     : Leave no gap below the
  319.                                                list but instead at the
  320.                                                end of the group.
  321.     TRAT_Value       : ULONG selected        : Currently selected entry
  322.                                                (TRLV_SHOWSELECTED only)
  323.     TRLV_Top         : ULONG top
  324.     TRAT_MinWidth    : ULONG minwidth        : Minimum width
  325.                                                (Default: 10 characters)
  326.     TRAT_MinHeight   : ULONG minheight       : Minimum height
  327.                                                (Default: 4 lines)
  328.  
  329.    MESSAGES
  330.     'Select' listviews send TRMS_ACTION messages. 'ShowSelected' lists
  331.     send TRMS_NEWVALUE messages. trm_Data contains the ordinal number
  332.     of the selected entry. trm_Qualifier&IEQUALIFIER_REPEAT is set if
  333.     the user has double-clicked the specified listview entry.
  334.  
  335.    BUGS
  336.     In triton.library v2 the fixed-width font handling was broken.
  337.  
  338. triton.library/class_Object                       triton.library/class_Object
  339.  
  340.    NAME    
  341.     class_Object -- The abstract root class
  342.  
  343.    SUPERCLASS
  344.     <none>
  345.  
  346.    SYNOPSIS
  347.     TROB_Object
  348.  
  349.    ATTRIBUTES
  350.     <Default>        : <unused>
  351.  
  352. triton.library/class_Palette                     triton.library/class_Palette
  353.  
  354.    NAME    
  355.     class_Palette -- A GadTools palette gadget
  356.  
  357.    SUPERCLASS
  358.     class_DisplayObject
  359.  
  360.    SYNOPSIS
  361.     TROB_Palette
  362.  
  363.    ATTRIBUTES
  364.     <Default>        : <unused>
  365.     TRAT_Value       : BOOL checked
  366.  
  367. triton.library/class_Progress                   triton.library/class_Progress
  368.  
  369.    NAME    
  370.     class_Progress -- A progress indicator
  371.  
  372.    SUPERCLASS
  373.     class_DisplayObject (no attributes inherited)
  374.  
  375.    SYNOPSIS
  376.     TROB_Progress
  377.  
  378.    ATTRIBUTES
  379.     <Default>        : ULONG maximum
  380.     TRAT_Flags       : ULONG orientation
  381.                        - TROF_HORIZ (default)
  382.                        - TROF_VERT
  383.     TRAT_ID          : ULONG objectid
  384.     TRAT_Value       : ULONG current
  385.  
  386. triton.library/class_Scroller                   triton.library/class_Scroller
  387.  
  388.    NAME    
  389.     class_Scroller -- A GadTools scroller gadget
  390.  
  391.    SUPERCLASS
  392.     class_DisplayObject (no attributes inherited)
  393.  
  394.    SYNOPSIS
  395.     TROB_Scroller
  396.  
  397.    ATTRIBUTES
  398.     <Default>        : ULONG flags
  399.                        - TROF_HORIZ        : Horizontal scroller
  400.                        - TROF_VERT         : Vertical scroller
  401.     TRAT_ID          : ULONG objectid
  402.     TRAT_Value       : WORD top
  403.     TRAT_Disabled    : BOOL disabled
  404.     TRSC_Total       : WORD total
  405.     TRSC_Visible     : WORD visible
  406.  
  407. triton.library/class_Slider                       triton.library/class_Slider
  408.  
  409.    NAME    
  410.     class_Slider -- A GadTools slider gadget
  411.  
  412.    SUPERCLASS
  413.     class_DisplayObject (no attributes inherited)
  414.  
  415.    SYNOPSIS
  416.     TROB_Slider
  417.  
  418.    ATTRIBUTES
  419.     <Default>        : ULONG flags
  420.                        - TROF_HORIZ (default)
  421.                        - TROF_VERT
  422.     TRAT_ID          : ULONG objectid
  423.     TRAT_Value       : WORD level
  424.     TRAT_Disabled    : BOOL disabled
  425.     TRSL_Min         : WORD min
  426.     TRSL_Max         : WORD max
  427.  
  428. triton.library/class_Space                         triton.library/class_Space
  429.  
  430.    NAME    
  431.     class_Space -- A class of spaces with various sizes
  432.  
  433.    SUPERCLASS
  434.     class_DisplayObject
  435.  
  436.    SYNOPSIS
  437.     TROB_Space
  438.  
  439.    ATTRIBUTES
  440.     <Default>        : ULONG spacetype
  441.                        - TRST_NONE         : No space
  442.                        - TRST_SMALL        : Small space
  443.                        - TRST_NORMAL       : Normal space (default)
  444.                        - TRST_BIG          : Big space
  445.  
  446. triton.library/class_String                       triton.library/class_String
  447.  
  448.    NAME    
  449.     class_String -- A GadTools string gadget
  450.  
  451.    SUPERCLASS
  452.     class_DisplayObject (no attributes inherited)
  453.  
  454.    SYNOPSIS
  455.     TROB_String
  456.  
  457.    ATTRIBUTES
  458.     <Default>        : STRPTR string
  459.     TRAT_ID          : ULONG objectid
  460.     TRAT_Disabled    : BOOL disabled
  461.     TRAT_Value       : UWORD maxchars (default: 64)
  462.                        [create only]
  463.  
  464. triton.library/class_Text                           triton.library/class_Text
  465.  
  466.    NAME    
  467.     class_Text -- A line of text / A value
  468.  
  469.    SUPERCLASS
  470.     class_DisplayObject (no attributes inherited)
  471.  
  472.    SYNOPSIS
  473.     TROB_Text
  474.  
  475.    ATTRIBUTES
  476.     <Default>        : <unused>
  477.     TRAT_ID          : ULONG objectid
  478.     TRAT_Text        : STRPTR text
  479.     TRAT_Value       : ULONG number
  480.     TRAT_MinWidth    : ULONG number_of_average_chars
  481.     TRAT_Flags       : ULONG flags
  482.                        - TRTX_NOUNDERSCORE    : Don't interpret underscores
  483.                        - TRTX_HIGHLIGHT       : Highlight text
  484.                        - TRTX_3D              : Highlight with shadows
  485.                        - TRTX_TITLE           : Use this for titles (e.g.
  486.                                                 of separator bars).
  487.                        - TROF_RIGHTALIGN (V2) : Align text to the right border
  488.                                                 of available space (e.g. in
  489.                                                 text boxes and arrays)
  490.  
  491.    BUGS
  492.     Below v2 of triton.library changing TRAT_Text while the text was
  493.     displayed did only work with text on a TRBF_WINDOWBACK object.
  494.  
  495. triton.library/TR_AutoRequest                   triton.library/TR_AutoRequest
  496.  
  497.    NAME    
  498.     TR_AutoRequest -- A (relatively ;-) low-level requester function.
  499.  
  500.    SYNOPSIS
  501.     selection = TR_AutoRequest(App, Project, TagList)
  502.     D0                         A1   A0       A2
  503.  
  504.     ULONG TR_AutoRequest(struct TR_App *, struct TR_Project *,
  505.                          struct AppItem *);
  506.  
  507.     selection = TR_AutoRequestTags(App, Project, Tag,...)
  508.     D0
  509.  
  510.     ULONG TR_AutoRequestTags(struct TR_App *, struct TR_Project *,
  511.                          struct AppItem *);
  512.  
  513.    FUNCTION
  514.     Pops up a requester which is described by the supplied tag list.
  515.     As soon as a TRMS_ACTION message is sent by one of the objects,
  516.     the requester will close. If a project is supplied, it will be
  517.     locked when opening the requester and unlocked when closing it.
  518.  
  519.    RESULT
  520.     selection - The ID of the object which triggered the action,
  521.                 NULL for an error, (ULONG)(-1) for the close gadget.
  522.  
  523.    NOTES
  524.     Simple requesters with just text and buttons can be done easier
  525.     with TR_EasyRequest(). If you need more complex requesters, you
  526.     have to use your own message polling loop instead of
  527.     TR_AutoRequest(). You may still use the requester macros though.
  528.  
  529.    SEE ALSO
  530.     TR_EasyRequest()
  531.  
  532. triton.library/TR_CloseProject                 triton.library/TR_CloseProject
  533.  
  534.    NAME    
  535.     TR_CloseProject -- Closes a project/window.
  536.  
  537.    SYNOPSIS
  538.     TR_CloseProject(Project)
  539.                     A0
  540.  
  541.     VOID TR_CloseProject(struct TR_Project *);
  542.  
  543.    FUNCTION
  544.     Closes a Triton project.
  545.  
  546.    SEE ALSO
  547.     TR_OpenProject()
  548.  
  549. triton.library/TR_CloseWindowSafely       triton.library/TR_CloseWindowSafely
  550.  
  551.    NAME    
  552.     TR_CloseWindowSafely -- Closes as window with a shared IDCMP port.
  553.  
  554.    SYNOPSIS
  555.     TR_CloseWindowSafely(Window)
  556.                          A0
  557.  
  558.     VOID TR_CloseWindowSafely(struct Window *);
  559.  
  560.    FUNCTION
  561.     Closes a window which shares its IDCMP port with another window.
  562.     All the pending messages (concerning this window) on the port
  563.     will be removed and the window will be closed.
  564.     
  565.     Do *NOT* use this function to close windows which have an IDCMP
  566.     port set up by Intuition. If you do the port will be left in memory!
  567.     
  568.     If you intend to open a lot of windows all sharing the same IDCMP
  569.     port it is easiest if you create a port yourself and open all
  570.     windows with newwin.IDCMPFlags set to 0 (this tells Intuition NOT to
  571.     set up an IDCMP port). After opening the window set win->UserPort
  572.     to your message port and call ModifyIDCMP() to set your IDCMP flags.
  573.     
  574.     When you then receive messages from Intuition check their
  575.     imsg->IDCMPWindow field to find out what window they came from
  576.     and act upon them.
  577.     
  578.     When closing your windows call TR_CloseWindowSafely() for all of
  579.     them and delete your message port.
  580.  
  581.    INPUTS
  582.     Window - pointer to the window to be closed.
  583.  
  584.    NOTE
  585.     This function is for the advanced Triton user.
  586.  
  587.    SEE ALSO
  588.     intuition.library/CloseWindow()
  589.  
  590. triton.library/TR_CreateApp                       triton.library/TR_CreateApp
  591.  
  592.    NAME    
  593.     TR_CreateApp -- Creates a Triton application.
  594.     TR_CreateAppTags -- Varargs stub for TR_CreateApp.
  595.  
  596.    SYNOPSIS
  597.     app = TR_CreateApp(TagList)
  598.     D0                 A1
  599.  
  600.     struct TR_App * TR_CreateApp(struct TagItem *);
  601.  
  602.     app = TR_CreateAppTags(Tag1,...)
  603.  
  604.     struct TR_App * TR_CreateApp(ULONG,...);
  605.  
  606.    FUNCTION
  607.     Creates an application. An application is required
  608.     for opening windows and polling messages. All projects
  609.     of an application will share one IDCMP port and one
  610.     memory pool.
  611.  
  612.    TAGS
  613.     TRCA_Name        - (STRPTR)
  614.                        Unique name for the application. Must not be
  615.                        longer than 20 characters. Case-insensitive.
  616.                        ' ', '/', '.' and ':' are not allowed.
  617.     TRCA_LongName    - (STRPTR)
  618.                        A user-readable name for the application.
  619.                        Up to 60 characters allowed.
  620.     TRCA_Info        - (STRPTR)
  621.                        Information about the application. Should not
  622.                        be more than 2 lines with 60 characters each.
  623.     TRCA_Version     - (STRPTR)
  624.                        Internal version of the application.
  625.     TRCA_Release     - (STRPTR)
  626.                        Release number of the application.
  627.     TRCA_Date        - (STRPTR)
  628.                        Creation/compilation date. Should be given
  629.                        in standard version string format.
  630.     
  631.     Example:
  632.       Name        : DilloCreate
  633.       LongName    : Armadillo Creator
  634.       Info        : Part of the Armadillo Management System.
  635.                     © 1994 by DilloWorks Enterprises.
  636.       Version     : 42.135
  637.       Release     : 2.1bß3
  638.       Date        : 17.6.94
  639.  
  640.    RESULT
  641.     app - A pointer to the created application structure.
  642.           NULL indicates failure.
  643.  
  644.    SEE ALSO
  645.     TR_DeleteApp()
  646.  
  647. triton.library/TR_DeleteApp                       triton.library/TR_DeleteApp
  648.  
  649.    NAME    
  650.     TR_DeleteApp -- Deletes a Triton application.
  651.  
  652.    SYNOPSIS
  653.     TR_DeleteApp(App)
  654.                  A1
  655.  
  656.     VOID TR_DeleteApp(struct TR_App *);
  657.  
  658.    FUNCTION
  659.     Deletes an application created by TR_CreateApp().
  660.  
  661.    NOTES
  662.     All windows have to be closed before deleting the
  663.     corresponding application!
  664.  
  665.    SEE ALSO
  666.     TR_CreateApp()
  667.  
  668. triton.library/TR_EasyRequest                   triton.library/TR_EasyRequest
  669.  
  670.    NAME    
  671.     TR_EasyRequest -- A high-level requester function.
  672.  
  673.    SYNOPSIS
  674.     selection = TR_EasyRequest(App, BodyFmt, GadFmt, TagList)
  675.     D0                         A1   A2       A3      A0
  676.  
  677.     ULONG TR_EasyRequest(struct TR_App *, STRPTR, STRPTR, struct TagItem *);
  678.  
  679.     selection = TR_EasyRequestTags(App, BodyFmt, GadFmt, Tag,...)
  680.     D0
  681.  
  682.     ULONG TR_EasyRequestTags(struct TR_App *, STRPTR, STRPTR, ULONG,...);
  683.  
  684.    FUNCTION
  685.     Pops up a requester and waits for the user to select a gadget.
  686.  
  687.    INPUTS
  688.     App       - A valid Triton application.
  689.     BodyFmt   - A formatted text which will be displayed in the
  690.                 requester body. A <newline> (\n) will start a new line
  691.                 with a small space above it. A <return> (\r) will add
  692.                 a normal space instead. A <tab> (\t) will add a normal
  693.                 space, then a 3D separator line and again a normal
  694.                 space. '%b' will switch to boldface, '%3' to 3D text,
  695.                 '%h' to highlight and '%n' to normal style (at the moment
  696.                 styles may only be changed at the beginning of a line!).
  697.                 Beginning with v2, '%s' ('Shadow') is allowed as an alias
  698.                 for '%3' because CatComp doesn't compile catalogs with
  699.                 '%3' in the description files.
  700.                 (Sigh, why is there no way of telling CatComp not to
  701.                 interpret '%' characters...)
  702.     GadFmt    - The gadget texts, separated by '|'.
  703.     TagList   - Pointer to a TagItem array.
  704.  
  705.    TAGS
  706.     TREZ_ReqPos      - (ULONG)
  707.                        The requester's position (TRWP_...).
  708.                        The default is TRWP_MOUSEPOINTER.
  709.     TREZ_LockProject - (struct TR_Project *)
  710.                        This project will be locked while the
  711.                        requester is displayed. Information about
  712.                        screen and activity state of the requester
  713.                        are taken from this project.
  714.     TREZ_Return      - (ULONG)
  715.                        Number of the default gadget which can be
  716.                        activated by <RETURN>. Defaults to 1 (0 in
  717.                        a single-gadget requester).
  718.     TREZ_Title       - (STRPTR)
  719.                        Requester window title. Default is
  720.                        "System request" (or a localized version under
  721.                        OS2.1 and higher).
  722.     TREZ_Activate    - (BOOL)
  723.                        If this tag is supplied, the activity state
  724.                        of the requester window will be taken from
  725.                        this tag's argument instead of being inherited
  726.                        from the locked project (if applicable).
  727.  
  728.    RESULT
  729.     selection - The number of the selected gadget. The gadgets are
  730.                 numbered from left to right beginning with 1. The
  731.                 rightmost gadget (or the only gadget in a 1-gadget
  732.                 requester) has got number 0. (ULONG)(-1) is returned
  733.                 for indicating an error.
  734.  
  735.    SEE ALSO
  736.     TR_AutoRequest()
  737.  
  738. triton.library/TR_FirstOccurance             triton.library/TR_FirstOccurance
  739.  
  740.    NAME    
  741.     TR_FirstOccurance -- Finds a character in a string.
  742.  
  743.    SYNOPSIS
  744.     Position = TR_FirstOccurance(Character, String)
  745.     D0                           D0         A0
  746.  
  747.     LONG TR_FirstOccurance(UBYTE, STRPTR);
  748.  
  749.    FUNCTION
  750.     Finds the specified character in the string.
  751.  
  752.    RESULT
  753.     Position - The position of the first occurance of the
  754.     character in the string or -1 if the character couldn't
  755.     be found in the string.
  756.  
  757. triton.library/TR_GetAttribute                 triton.library/TR_GetAttribute
  758.  
  759.    NAME    
  760.     TR_GetAttribute -- Gets an attribute of an object.
  761.  
  762.    SYNOPSIS
  763.     value = TR_GetAttribute(Project, ID, Attribute)
  764.     D0                      A0       D0  D1
  765.  
  766.     ULONG TR_GetAttribute(struct TR_Project *, ULONG,
  767.                           ULONG, ULONG);
  768.  
  769.    FUNCTION
  770.     Gets an attribute of a Triton object. Only attributes
  771.     of objects with an ID can be queried.
  772.  
  773.    RESULT
  774.     value - Value of the specified attribute. Depends
  775.             on specific class and attribute.
  776.  
  777.    SEE ALSO
  778.     Class descriptions, TR_SetAttribute()
  779.  
  780. triton.library/TR_GetErrorString             triton.library/TR_GetErrorString
  781.  
  782.    NAME    
  783.     TR_GetErrorString -- Creates an error message
  784.  
  785.    SYNOPSIS
  786.     Message = TR_GetErrorString(Number)
  787.     D0                          D0
  788.  
  789.     STRPTR TR_GetErrorString(UWORD);
  790.  
  791.    FUNCTION
  792.     Creates an error message which matches the supplied
  793.     Triton error code.
  794.  
  795.    INPUTS
  796.     Number - Triton error code. In most cases you will
  797.              get this with TR_GetLastError().
  798.  
  799.    RESULT
  800.     Message - Pointer to a user-readable error message
  801.  
  802.    SEE ALSO
  803.     TR_GetLastError()
  804.  
  805. triton.library/TR_GetLastError                 triton.library/TR_GetLastError
  806.  
  807.    NAME    
  808.     TR_GetLastError -- Gets the last error code
  809.  
  810.    SYNOPSIS
  811.     Number = TR_GetLastError(App)
  812.     D0                       A1
  813.  
  814.     UWORD TR_GetLastError(struct TR_App *);
  815.  
  816.    FUNCTION
  817.     Returns the TRER code of the last error which occured
  818.     in the application and sets the internal tra_LastError
  819.     back to TRER_OK.
  820.  
  821.    INPUTS
  822.     App - Pointer to a Triton Application
  823.  
  824.    RESULT
  825.     Number - TRER error code
  826.  
  827.    SEE ALSO
  828.     TR_GetErrorString()
  829.  
  830. triton.library/TR_GetMsg                             triton.library/TR_GetMsg
  831.  
  832.    NAME    
  833.     TR_GetMsg -- Gets a Triton message.
  834.  
  835.    SYNOPSIS
  836.     message = TR_GetMsg(App)
  837.     D0                  A1
  838.  
  839.     struct TR_Message * TR_GetMsg(struct TR_App *);
  840.  
  841.    FUNCTION
  842.     Gets a message from a Triton application created
  843.     by TR_CreateApp(). You may first wait for a message
  844.     with TR_Wait().
  845.  
  846.    NOTES
  847.     Please reply all messages as quickly as possible
  848.     with TR_ReplyMsg(). This will reduce memory usage.
  849.     All pending messages will be freed automatically when
  850.     you shut down the application with TR_DeleteApp().
  851.     It is *NOT* guaranteed that all reserved resources
  852.     *within* the messages will be freed (like AppMessages)!
  853.  
  854.    SEE ALSO
  855.     TR_ReplyMsg(), TR_Wait()
  856.  
  857. triton.library/TR_LockProject                   triton.library/TR_LockProject
  858.  
  859.    NAME    
  860.     TR_LockProject -- Locks a Triton project.
  861.  
  862.    SYNOPSIS
  863.     TR_LockProject(Project)
  864.                    A0
  865.  
  866.     VOID TR_LockProject(struct TR_Project *);
  867.  
  868.    FUNCTION
  869.     Locks a Triton project. Only window resizing will
  870.     still work in a locked project. All other kinds of
  871.     input (i.e. all input which requires interaction
  872.     by your program and not only by Triton) are not
  873.     possible.
  874.  
  875.    SEE ALSO
  876.     TR_UnlockProject()
  877.  
  878. triton.library/TR_LockScreen                     triton.library/TR_LockScreen
  879.  
  880.    NAME    
  881.     TR_LockScreen -- Get a project's screen
  882.  
  883.    SYNOPSIS
  884.     screen = TR_LockScreen(Project)
  885.     D0                     A0
  886.  
  887.     struct Screen * TR_LockScreen(struct TR_Project *);
  888.  
  889.    FUNCTION
  890.     Lock the screen of a Triton project for use with non-Triton
  891.     windows (e.g. for opening a file requester on the screen of a
  892.     Triton application). The screen must be unlocked later with
  893.     TR_UnlockScreen(). Locking/unlocking calls are nested.
  894.  
  895.    RESULT
  896.     screen - Pointer to the project's screen or NULL to indicate an
  897.              error. In this case the application should *not* abort,
  898.              but *quietly* use another screen (preferably the
  899.              Workbench screen) instead.
  900.  
  901.    SEE ALSO
  902.     TR_UnlockScreen()
  903.  
  904. triton.library/TR_NumOccurances               triton.library/TR_NumOccurances
  905.  
  906.    NAME    
  907.     TR_NumOccurances -- Counts a character in a string.
  908.  
  909.    SYNOPSIS
  910.     Number = TR_NumOccurances(Character, String)
  911.     D0                        D0         A0
  912.  
  913.     LONG TR_NumOccurances(UBYTE, STRPTR);
  914.  
  915.    FUNCTION
  916.     Counts the number of occurances of the character in the string.
  917.  
  918.    RESULT
  919.     Number - The number of occurances found.
  920.  
  921. triton.library/TR_ObtainWindow                 triton.library/TR_ObtainWindow
  922.  
  923.    NAME    
  924.     TR_ObtainWindow -- Get a project's window
  925.  
  926.    SYNOPSIS
  927.     window = TR_ObtainWindow(Project)
  928.     D0                       A0
  929.  
  930.     struct Window * TR_ObtainWindow(struct TR_Project *);
  931.  
  932.    FUNCTION
  933.     Lock the window of a Triton project for non-Triton window
  934.     operations (e.g. activating a window or bringing it to the
  935.     front). Do not manipulate the contents of Triton windows!
  936.     Locked windows must be freed again with TR_UnlockWindow().
  937.     Locking/unlocking calls are nested.
  938.  
  939.    RESULT
  940.     window - Pointer to the project's Window. A value of NULL should
  941.              be quietly ignored. NULL simply indicates that there is
  942.              currently no window available.
  943.  
  944.    SEE ALSO
  945.     TR_UnlockWindow()
  946.  
  947. triton.library/TR_OpenProject                   triton.library/TR_OpenProject
  948.  
  949.    NAME    
  950.     TR_OpenProject -- Opens a project/window.
  951.     TR_OpenProjectTags -- Varargs stub for TR_OpenProject.
  952.  
  953.    SYNOPSIS
  954.     Project = TR_OpenProject(App, TagItems)
  955.     D0                       A1   A0
  956.  
  957.     struct TR_Project *TR_OpenProject(struct TR_App *,
  958.                                       struct TagItem *);
  959.  
  960.     Project = TR_OpenProjectTags(App, Tag1,...)
  961.  
  962.     struct TR_Project *TR_OpenProjectTags(struct TR_App *,
  963.                                           ULONG,...);
  964.  
  965.    FUNCTION
  966.     Opens a Triton project. The supplied taglist may contain
  967.     window tags, menu tags and object tags (in that order).
  968.     Mutually exclusive menus are not yet supported. When creating
  969.     a menu item with an ID, TRAT_ID must be the *last* tag.
  970.     A valid application pointer must be supplied.
  971.  
  972.    INPUTS
  973.     App = Valid application pointer
  974.     TagItems = List of tags describing the project
  975.  
  976.    TAGS
  977.     The taglist may contain window tags, menu tags and object tags
  978.     (in that order!). The following list shows the window and menu
  979.     tags. See the class descriptions for the object tags.
  980.  
  981.     TRWI_Title (STRPTR) - The window title
  982.  
  983.     TRWI_ScreenTitle (STRPTR) - The screen title (V2)
  984.  
  985.     TRWI_Flags (ULONG) - The Triton window flags:
  986.     - TRWF_BACKDROP        : Create a backdrop borderless window
  987.                              in full screen size
  988.     - TRWF_NODRAGBAR       : No dragging bar
  989.     - TRWF_NODEPTHGADGET   : No depth arranging gadget
  990.     - TRWF_NOCLOSEGADGET   : No close gadget
  991.     - TRWF_NOACTIVE        : Don't activate window
  992.     - TRWF_NOESCCLOSE      : Don't send TRMS_CLOSEWINDOW when
  993.                              Esc is pressed
  994.     - TRWF_NOPSCRFALLBACK  : Don't fall back onto default PubScreen
  995.     - TRWF_NOZIPGADGET     : No zip/zoom gadget
  996.     - TRWF_ZIPCENTERTOP    : Center zipped window on screen title bar
  997.     - TRWF_NOMINTEXTWIDTH  : Window title text length doesn't count
  998.                              for window size calculation
  999.     - TRWF_NOSIZEGADGET    : No size gadget
  1000.     - TRWF_NOFONTFALLBACK  : Don't fall back to topaz/8
  1001.     - TRWF_NODELZIP        : Don't zip the window when Del is pressed
  1002.     - TRWF_SIMPLEREFRESH   : Use simple instead of smart refresh. (V1)
  1003.                              This flag is *obsolete* in V3+!
  1004.                              The refresh type is now set by the user.
  1005.     - TRWF_ZIPTOCURRENTPOS : Zip the window without changing its
  1006.                              position. Requires OS3.0 or higher.
  1007.     - TRWF_APPWINDOW       : Create an AppWindow even if no object
  1008.                              reacts on dropped icons
  1009.     - TRWF_ACTIVATESTRGAD  : Activate the first string gadget after
  1010.                              opening the window
  1011.     - TRWF_HELP            : When the user presses <Help> over a menu
  1012.                              item or a display object, a TRMS_HELP
  1013.                              message will be sent (V2)
  1014.  
  1015.     TRWI_Underscore (UBYTE *) - The underscore for menu and gadget
  1016.         shortcuts. The default is "_".
  1017.  
  1018.     TRWI_Position (ULONG) - The window position:
  1019.     - TRWP_DEFAULT         : Let Triton choose a good position for
  1020.                              the window
  1021.     - TRWP_BELOWTITLEBAR   : Left side of screen; below the title bar
  1022.     - TRWP_CENTERTOP       : Top of screen; centered on the title bar
  1023.     - TRWP_TOPLEFTSCREEN   : Top left corner of screen
  1024.     - TRWP_CENTERSCREEN    : Centered on the screen
  1025.     - TRWP_CENTERDISPLAY   : Centered on the currently displayed clip
  1026.     - TRWP_MOUSEPOINTER    : Centered under the mouse pointer
  1027.  
  1028.     TRWI_CustomScreen (struct Screen *) - A custom screen on which
  1029.         the window will be opened
  1030.  
  1031.     TRWI_PubScreen (struct Screen *) - A public screen on which the
  1032.         window will be opened. The screen *must* have been locked.
  1033.  
  1034.     TRWI_PubScreenName (STRPTR) - A public screen on which the window
  1035.         will be opened. Triton will try to lock the screen with the
  1036.         specified name. It will fall back onto the default public
  1037.         screen in case the screen can't be found/locked if you don't
  1038.         specify TRWF_NOPSCRFALLBACK.
  1039.  
  1040.     TRWI_PropFontAttr (struct TextAttr *) - The proportional font. If
  1041.         Triton can't open the font or the window would become too big
  1042.         for the screen with this font and you didn't specify
  1043.         TRWF_NOFONTFALLBACK, Triton will try to use topaz/8 instead.
  1044.  
  1045.     TRWI_FixedWidthFontAttr (struct TextAttr *) - The fixed-width
  1046.         font. If Triton can't open the font or the window would
  1047.         become too big for the screen with this font and you didn't
  1048.         specify TRWF_NOFONTFALLBACK, Triton will try to use topaz/8
  1049.         instead.
  1050.  
  1051.     TRWI_Backfill (ULONG) - The backfill type:
  1052.     - TRBF_WINDOWBACK        : Default window background; Can be
  1053.                                changed by the user in the Triton
  1054.                                Preferences editor
  1055.     - TRBF_REQUESTERBACK     : Default requester background; Can be
  1056.                                changed by the user in the Triton
  1057.                                Preferences editor
  1058.     - TRBF_NONE              : No backfill (i.e. fill with
  1059.                                BACKGROUNDPEN)
  1060.     - TRBF_SHINE             : Fill with SHINEPEN
  1061.     - TRBF_SHADOW            : Fill with SHADOWPEN
  1062.     - TRBF_FILL              : Fill with FILLPEN
  1063.     - TRBF_SHINE_SHADOW      : Fill with a pattern composed of
  1064.                                SHINEPEN and SHADOWPEN
  1065.     - TRBF_SHINE_FILL        : ~ SHINEPEN and FILLPEN
  1066.     - TRBF_SHINE_BACKGROUND  : ~ SHINEPEN and BACKGROUNDPEN
  1067.     - TRBF_SHADOW_FILL       : ~ SHADOWPEN and FILLPEN
  1068.     - TRBF_SHADOW_BACKGROUND : ~ SHADOWPEN and BACKGROUNDPEN
  1069.     - TRBF_FILL_BACKGROUND   : ~ FILLPEN and BACKGROUNDPEN
  1070.  
  1071.     TRWI_ID (ULONG) - An ID for the window. Identical windows (e.g.
  1072.         several identical data editor windows) should share the same
  1073.         ID. Different applications may share the same IDs.
  1074.  
  1075.     TRWI_Dimensions (struct TR_Dimensions *) - A window dimension
  1076.         structure. The user program must supply a structure on its
  1077.         own if it wants to use this feature. Triton will *not*
  1078.         allocate it. If you use a dimensions structure, Triton will
  1079.         copy the window dimensions into it when you close the window.
  1080.         If you supply a filled-in dimension structure, Triton will try
  1081.         to open the window with these dimensions. Supply an empty
  1082.         structure if you want Triton to use the default dimensions (the
  1083.         position may then be specified with TRWI_Position) and fill
  1084.         in the structure for later use.
  1085.  
  1086.     TRMN_Title (STRPTR) - A menu label
  1087.  
  1088.     TRMN_Item (STRPTR) - A menu item label. You may attach a
  1089.         keyboard shortcut to a menu by starting the label string
  1090.         with the shortcut followed by the project's underscore
  1091.         character and then the actual label. You may also use
  1092.         extended menu shortcuts composed of more than one character.
  1093.         Extended shortcuts can be specified with an underscore at
  1094.         the beginning, then the shortcut, again an underscore and
  1095.         the label. You may specify TRMN_BARLABEL instead of a string
  1096.         to create a separator bar in the menu.
  1097.  
  1098.     TRMN_Sub (STRPTR) - A sub-menu item label. See TRMN_Item.
  1099.  
  1100.     TRMN_Flags (ULONG) - Flags for a menu item:
  1101.     - TRMF_CHECKIT         : The menu item may be checked.
  1102.     - TRMF_CHECKED         : The menu item is checked. You may, but
  1103.                              you do not need to specify TRMF_CHECKIT
  1104.                              in addition.
  1105.     - TRMF_DISABLED        : The menu / (sub) item will be ghosted.
  1106.  
  1107.    RESULT
  1108.     Project - The pointer to the TR_Project structure
  1109.  
  1110.    SEE ALSO
  1111.     TR_CloseProject()
  1112.  
  1113. triton.library/TR_ReleaseWindow               triton.library/TR_ReleaseWindow
  1114.  
  1115.    NAME    
  1116.     TR_ReleaseWindow -- Release a project's window
  1117.  
  1118.    SYNOPSIS
  1119.     TR_ReleaseWindow(Window)
  1120.                     A0
  1121.  
  1122.     VOID TR_ReleaseWindow(struct Window *);
  1123.  
  1124.    FUNCTION
  1125.     Unlock a window which has been locked by TR_ObtainWindow(). All
  1126.     locked windows must be unlocked! Locking/unlocking calls are
  1127.     nested.
  1128.  
  1129.    SEE ALSO
  1130.     TR_ObtainWindow()
  1131.  
  1132. triton.library/TR_ReplyMsg                         triton.library/TR_ReplyMsg
  1133.  
  1134.    NAME    
  1135.     TR_ReplyMsg -- Replies a Triton message.
  1136.  
  1137.    SYNOPSIS
  1138.     TR_ReplyMsg(Message)
  1139.                 A1
  1140.  
  1141.     VOID TR_ReplyMsg(struct TR_Message *);
  1142.  
  1143.    FUNCTION
  1144.     Replies a message allocated by TR_GetMsg().
  1145.  
  1146.    NOTES
  1147.     Please reply all messages as quickly as possible
  1148.     with TR_ReplyMsg(). This will reduce memory usage.
  1149.     All pending messages will be freed automatically when
  1150.     you shut down the application with TR_DeleteApp().
  1151.     It is *NOT* guaranteed that all reserved resources
  1152.     *within* the messages will be freed (like AppMessages)!
  1153.  
  1154.    SEE ALSO
  1155.     TR_GetMsg(), TR_Wait()
  1156.  
  1157. triton.library/TR_SetAttribute                 triton.library/TR_SetAttribute
  1158.  
  1159.    NAME    
  1160.     TR_SetAttribute -- Sets an attribute of an object.
  1161.  
  1162.    SYNOPSIS
  1163.     TR_SetAttribute(Project, ID, Attribute, Value)
  1164.                     A0       D0  D1         D2
  1165.  
  1166.     VOID TR_SetAttribute(struct TR_Project *, ULONG,
  1167.                          ULONG, ULONG, ULONG);
  1168.  
  1169.    FUNCTION
  1170.     Sets an attribute of a Triton object. Only attributes
  1171.     of objects with an ID can be changed. You can change the
  1172.     default attribute of an object by specifying NULL as
  1173.     the attribute to change. By specifying an ID of NULL, you
  1174.     can change certain attributes of a Triton project:
  1175.     - TRWI_Title
  1176.     - TRWI_ScreenTitle
  1177.  
  1178.    SEE ALSO
  1179.     Class descriptions, TR_GetAttribute()
  1180.  
  1181. triton.library/TR_UnlockProject               triton.library/TR_UnlockProject
  1182.  
  1183.    NAME    
  1184.     TR_UnlockProject -- Unlocks a Triton project.
  1185.  
  1186.    SYNOPSIS
  1187.     TR_UnlockProject(Project)
  1188.                      A0
  1189.  
  1190.     VOID TR_UnlockProject(struct TR_Project *);
  1191.  
  1192.    FUNCTION
  1193.     Unlocks a Triton project previously locked by
  1194.     TR_LockProject().
  1195.  
  1196.    SEE ALSO
  1197.     TR_LockProject()
  1198.  
  1199. triton.library/TR_UnlockScreen                 triton.library/TR_UnlockScreen
  1200.  
  1201.    NAME    
  1202.     TR_UnlockScreen -- Release a project's screen
  1203.  
  1204.    SYNOPSIS
  1205.     TR_UnlockScreen(Screen)
  1206.                     A0
  1207.  
  1208.     VOID TR_UnlockScreen(struct Screen *);
  1209.  
  1210.    FUNCTION
  1211.     Unlock a screen which has been locked by TR_LockScreen(). All
  1212.     locked screens must be unlocked! Locking/unlocking calls are
  1213.     nested.
  1214.  
  1215.    SEE ALSO
  1216.     TR_LockScreen()
  1217.  
  1218. triton.library/TR_Wait                                 triton.library/TR_Wait
  1219.  
  1220.    NAME    
  1221.     TR_Wait -- Waits for exec signals.
  1222.  
  1223.    SYNOPSIS
  1224.     Signals = TR_Wait(App, OtherBits)
  1225.             A1   D0
  1226.  
  1227.     ULONG TR_Wait(struct TR_App *, ULONG);
  1228.  
  1229.    FUNCTION
  1230.     Waits until a signal of the specified application
  1231.     or one of the other signal bits is set.
  1232.  
  1233.    RESULT
  1234.     Signals - The mask of set signals
  1235.  
  1236.    SEE ALSO
  1237.     TR_GetMsg(), TR_ReplyMsg()
  1238.  
  1239.